org.springframework.core.codec

Class DataBufferEncoder

java.lang.Object

org.springframework.core.codec.AbstractEncoder<DataBuffer>

org.springframework.core.codec.DataBufferEncoder

All Implemented Interfaces:

Encoder<DataBuffer>

public class DataBufferEncoder
extends AbstractEncoder<DataBuffer>

Simple pass-through encoder for DataBuffers.

Since:

5.0

Author:

Arjen Poutsma

Constructor Summary

Constructors

Constructor and Description
DataBufferEncoder()

Method Summary

Modifier and Type	Method and Description
boolean	canEncode(ResolvableType elementType, MimeType mimeType) Whether the encoder supports the given source element type and the MIME type for the output stream.
<any>	encode(<any> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, java.util.Map<java.lang.String,java.lang.Object> hints) Encode a stream of Objects of type T into a DataBuffer output stream.
java.lang.Long	getContentLength(DataBuffer dataBuffer, MimeType mimeType) Return the length for the given item, if known.

Methods inherited from class org.springframework.core.codec.AbstractEncoder

getEncodableMimeTypes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataBufferEncoder

public DataBufferEncoder()

Method Detail

canEncode

public boolean canEncode(ResolvableType elementType,
                         @Nullable
                         MimeType mimeType)

Description copied from interface: Encoder

Whether the encoder supports the given source element type and the MIME type for the output stream.

Specified by:

canEncode in interface Encoder<DataBuffer>

Overrides:

canEncode in class AbstractEncoder<DataBuffer>

Parameters:

elementType - the type of elements in the source stream

mimeType - the MIME type for the output stream (can be null if not specified)

Returns:

true if supported, false otherwise

encode

public <any> encode(<any> inputStream,
                    DataBufferFactory bufferFactory,
                    ResolvableType elementType,
                    @Nullable
                    MimeType mimeType,
                    @Nullable
                    java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: Encoder

Encode a stream of Objects of type T into a DataBuffer output stream.

Parameters:

inputStream - the input stream of Objects to encode. If the input should be encoded as a single value rather than as a stream of elements, an instance of Mono should be used.

bufferFactory - for creating output stream DataBuffer's

elementType - the expected type of elements in the input stream; this type must have been previously passed to the Encoder.canEncode(org.springframework.core.ResolvableType, org.springframework.util.MimeType) method and it must have returned true.

mimeType - the MIME type for the output stream (optional)

hints - additional information about how to do encode

Returns:

the output stream

getContentLength

public java.lang.Long getContentLength(DataBuffer dataBuffer,
                                       @Nullable
                                       MimeType mimeType)

Description copied from interface: Encoder

Return the length for the given item, if known.

Parameters:

dataBuffer - the item to check

Returns:

the length in bytes, or null if not known.